Update README with Installation and Table Of Contents #68
Conversation
|
Thank you for this! Admittedly, I'm not experienced with the different packaging options out there. I mostly use After reading through the changes, I see that Other notes: For the ToC, I guess a lot of people don't know this, but GitHub has it built in: I'd rather not have to maintain it manually as the README changes. Also, I've found that almost nothing we (programmers) do is easy. I tend to not use words like |
|
Also, I've never published a crate before. Any help you might have with that would be huge! |
You make a good point, I'll adjust that wording and remove the TOC section in that case. I still think listing package options is a good idea. Speaking for myself, I always prefer to install something via a package manager, and manually installing a GitHub release is the last resort. Of course, packaging for every conceivable platform is not feasible. I personally use Basically, I think it doesn't hurt to list the AUR, since it already exists, and the
I'm not a Rust programmer so neither have I 😉 but it would definitely be important to figure out, since I think |
|
Great! I didn't mean to say that the different packaging options should not be listed, sorry for the confusion. I get that everyone and every platform has their preferred solution. We definitely need a section on that! |
|
Removed the TOC and removed the "easily install" wording |
|
Looks great! Thanks again. |
I recently discovered this project and really like it, but I was frustrated by the lack of easy installation instructions, so I created an Arch User Repository package for Codebook's binary release. In adding it to the README, I also included more precise instructions for installing from the release manually, as well as using eget. Finally, I added a table of contents under a dropdown to the top of the document because there are a lot of sections and it's easy to get lost.
Once the
cargoinstallation method discussed in #61 is implemented, it could be added to this section and noted as the "preferred" way to install the package. Finally, if you think this makes the README too crammed/busy, we could wrap the installation instructions in another<details>dropdown. Please let me know what you think.