Updated README with installation guide and contribution #16
+98
−26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
petrasovaa
requested changes
Jan 30, 2025
| GIS](https://grass.osgeo.org), an open-source platform for geospatial analysis | ||
| and modeling. The tutorials cover a variety of topics and is designed to help | ||
| users at different skill levels. | ||
| ## 📌 What is GRASS GIS? |
There was a problem hiding this comment.
Keep the current intro, no need to have detailed explanation what is GRASS, this is not GRASS repo.
|
|
||
| ## Contributing | ||
| ## 🚀 Installation Guide |
There was a problem hiding this comment.
Keep contributing (guide) as the heading, installing quarto is a prerequisite,
Comment on lines
+9
to
+12
| Before installing, make sure you have the following dependencies: | ||
| - **Git** → [Download Git](https://git-scm.com/downloads) | ||
| - **Quarto** → [Install Quarto](https://quarto.org/docs/get-started/) | ||
| - **Python** (optional, for Python-based tutorials) → [Download Python](https://www.python.org/downloads/) |
There was a problem hiding this comment.
Keep it simple, if you are contributing a GRASS tutorial, it's likely you already have Python, and you don't necessarily need git locally.
| explained in the [GitHub | ||
| guide](https://github.com/OSGeo/grass/blob/main/doc/development/github_guide.md) | ||
| written for OSGeo/grass repository, so just adjust it for this repository. | ||
| ### 🔹 2. Clone the Repository |
There was a problem hiding this comment.
Avoid describing standard github workflow, link to existing grass github guide.
|
|
||
| The initial content of this website was supported by funding from the |
| Edit | ||
| Now, you can browse the tutorials on your local machine. | ||
|
|
||
| ## 📚 How to Use the Tutorials |
There was a problem hiding this comment.
No need for this, should be obvious
| ## 📢 Contact & Community | ||
| For questions or suggestions, open an **issue** or reach out via the **[GRASS GIS community channels](https://grass.osgeo.org/community/)**. | ||
|
|
||
| ### 🎯 Final Notes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Why This Change?
Request for Review