[DOC] Adding a brief documentation for standalone sub-section's Steel book #160
Conversation
docs/src/start/standalone.md
Outdated
| 5. Then run `exec elvish` and your are good to go! You can check your newly added path by typing:\ | ||
| `pprint $paths` | ||
|
|
||
| - For those who still live in the dark caves of ancient shells like Bash or Zsh, simply feed the new path like the |
There was a problem hiding this comment.
IMO: I would move bash and zsh up as they have higher adoption. Also remove language that makes any judgement on which is better to avoid alienating any users.
docs/src/start/standalone.md
Outdated
| ## Running a Steel file | ||
|
|
||
| 6. Finally, compile and execute your Steel files from your terminal like so:\ | ||
| `steel \<steel_file.scm\>` |
There was a problem hiding this comment.
Can you add another section for how to install the built in modules?
The instructions right now are encoded in the CI: https://github.com/mattwparas/steel/blob/master/.github/workflows/rust.yml#L44
There was a problem hiding this comment.
I tried what I understood but some concepts are beyond me. What is a cog? Why adopting .steel as a default installation?
Do I had to add all install related commands?
Also, I clicked the Sync fork button in my personal repository then chose the Update branch option. Will it cause some inconveniences to target the upstream repository?
I am a very beginner so I am straightforward even if I could pass as a silly person doing so.
…ief explanation regarding to built-in modules' installation
docs/src/start/standalone.md
Outdated
| 9. Finally, install the code coverage tool test, which will be of great use in the case you intend to contribute to | ||
| Steel development: | ||
| `cargo install cargo-tapaulin` |
There was a problem hiding this comment.
I don't think this is necessary to include here
docs/src/start/standalone.md
Outdated
| You can try a hidden directory to avoid remove it by accident: | ||
| `export PATH=${PWD}/.steel:$PATH` |
There was a problem hiding this comment.
I don't have the .steel directory added to my path - I don't think it is a thing that needs to be endorsed here
… and add 'Updating the compiler' sub-section
This is a first iteration of the sub-section Steel book regarding to the standalone procedure in order to run Steel files from a terminal, either using cargo tool or independently.
This is my very first pull request in life so if something wrong or misplaced, please do alert me and I will try my best to amend it! :-)