Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md to provide installation guide for mac / linux users #322

Conversation

Owen-CH-Leung
Copy link
Contributor

  • 馃摍 Documentation : Update the README.md to provide a detailed installation guide for mac & linux users.

Closes #320 .

馃摐 Checklist

  • Works on the ./demo sub directory
  • Test coverage is excellent and passes
  • Documentation is thorough

Provide installation guide when installing in Mac / Linux
@Owen-CH-Leung Owen-CH-Leung changed the title Update README.md Update README.md to provide installation guide for mac / linux users Jan 20, 2024
@Owen-CH-Leung
Copy link
Contributor Author

@drahnr Just fixed the failing CI test. Can I seek your review ? Many thanks

@drahnr drahnr force-pushed the update_readme_for_installation_guide branch from 398570f to 2616957 Compare May 27, 2024 08:25
README.md Outdated
@@ -61,6 +61,33 @@ cargo spellcheck fix
The `--locked` flag is the preferred way of installing to get the tested set of
dependencies.

in Mac, you'd need to ensure that `libclang.dylib` can be found by the linker
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
in Mac, you'd need to ensure that `libclang.dylib` can be found by the linker
on OS X, you need to ensure that `libclang.dylib` can be found by the linker

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Owner

@drahnr drahnr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few nits, otherwise LGTM. Thank you! Sorry for the long delay, life happened

@drahnr
Copy link
Owner

drahnr commented May 28, 2024

Could you squash it into one commit, then we can merge it :) Thank you!

@Owen-CH-Leung
Copy link
Contributor Author

A few nits, otherwise LGTM. Thank you! Sorry for the long delay, life happened

Thanks. Updated README.md as per your suggestions =)

Bumps [h2](https://github.com/hyperium/h2) from 0.3.21 to 0.3.26.
- [Release notes](https://github.com/hyperium/h2/releases)
- [Changelog](https://github.com/hyperium/h2/blob/v0.3.26/CHANGELOG.md)
- [Commits](hyperium/h2@v0.3.21...v0.3.26)

---
updated-dependencies:
- dependency-name: h2
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

chore(deps): bump rustls from 0.21.7 to 0.21.11

Bumps [rustls](https://github.com/rustls/rustls) from 0.21.7 to 0.21.11.
- [Release notes](https://github.com/rustls/rustls/releases)
- [Changelog](https://github.com/rustls/rustls/blob/main/CHANGELOG.md)
- [Commits](rustls/rustls@v/0.21.7...v/0.21.11)

---
updated-dependencies:
- dependency-name: rustls
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

fix dead_code compile error

Removes the unused CommonLang type.

chore/deps: bump pulldown-cmark to 0.10.0

chore: fmt

chore/deps: cargo_toml, itertools, fancy-regex, env_logger

chore/deps: bump ra_ap_syntax

chore: clippy, disable pedantic, explicitly allow a few pedantic

chore: bail if neither feature of `nlprules` or `hunspell` were set.

release: v0.14.0

feat: ignore math content enclodes by `$`

build: run cargo update to make it compile for riscv64

Update README.md

Provide installation guide when installing in Mac / Linux

Fix failing CI

Revise ReadME
@Owen-CH-Leung Owen-CH-Leung force-pushed the update_readme_for_installation_guide branch from 34713c2 to 38bb7a6 Compare May 28, 2024 15:14
@Owen-CH-Leung
Copy link
Contributor Author

bad rebase =( Let me create another branch instead

@Owen-CH-Leung
Copy link
Contributor Author

@drahnr Here:

#331

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Installing the crate in a macbook machine
2 participants