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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to document the new package layout and how to use it #46

Open
NoahAndrews opened this issue May 10, 2023 · 1 comment
Open
Assignees

Comments

@NoahAndrews
Copy link
Member

No description provided.

@LandryNorris
Copy link
Contributor

LandryNorris commented May 11, 2023

I plan to list the packages as a numeric list. The markdown spec allows numeric lists to be specified with a 1. at the start of each line. I generally prefer this, since it allows us to add items to the middle of the list without having to commit a change for every following item. IntelliJ-based IDEs typically warn about this, since they can automatically update the numbers. Most people will be viewing a README via GitHub's interface or an IDE that should recognize markdown and automatically show the right numbers.

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

No branches or pull requests

2 participants