Skip to content

Conversation

@mrfloris
Copy link

some basic readme stuff for a repo

some basic readme stuff for a repo
Comment on lines +33 to +49
3. **Install dependencies:**

Depending on the documentation framework used (e.g., MkDocs, Docusaurus), install the necessary dependencies. For example, if using MkDocs:

```bash
pip install mkdocs
```

4. **Serve the documentation locally:**

```bash
mkdocs serve
```

Then, open [http://localhost:8000](http://localhost:8000) in your browser to view the documentation.

*Note: Please adjust the above steps according to the specific tools and frameworks used in your project.*
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
3. **Install dependencies:**
Depending on the documentation framework used (e.g., MkDocs, Docusaurus), install the necessary dependencies. For example, if using MkDocs:
```bash
pip install mkdocs
```
4. **Serve the documentation locally:**
```bash
mkdocs serve
```
Then, open [http://localhost:8000](http://localhost:8000) in your browser to view the documentation.
*Note: Please adjust the above steps according to the specific tools and frameworks used in your project.*

We aren't using mkdocs, we use docsify which handles all the hard work for us, probably not a need for this since contributors would only be looking at markdown files anyways?

no need for license mention - leave up to dev

Co-authored-by: longbow122 <[email protected]>
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.

3 participants