Skip to content

Conversation

@SuvigyaSrivastava
Copy link

Summary

  • Improved README by adding an installation guide and usage instructions.
  • Included steps to clone, install dependencies, and run tutorials locally.
  • Updated contribution guide for clarity.

Why This Change?

  • The README was missing setup instructions.
  • New users can now quickly understand how to install and run the tutorials.

Request for Review

  • Can you please review it !

Copy link
Contributor

@petrasovaa petrasovaa left a comment

Choose a reason for hiding this comment

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

Thanks! This needs still some work though and clean up.

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?
Copy link
Contributor

Choose a reason for hiding this comment

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

Keep the current intro, no need to have detailed explanation what is GRASS, this is not GRASS repo.

[GRASS GIS](https://grass.osgeo.org) (**Geographic Resources Analysis Support System**) is a **free and open-source Geographic Information System (GIS)** used for geospatial data management, spatial modeling, visualization, and analysis. It supports **raster and vector data processing**, and is widely used in **academia, research, and professional GIS applications**.

## Contributing
## 🚀 Installation Guide
Copy link
Contributor

Choose a reason for hiding this comment

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

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/)
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid describing standard github workflow, link to existing grass github guide.

Copy
Edit

The initial content of this website was supported by funding from the
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to stay.

Edit
Now, you can browse the tutorials on your local machine.

## 📚 How to Use the Tutorials
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove

Copy link
Contributor

Choose a reason for hiding this comment

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

Remove

@cwhite911
Copy link
Contributor

cwhite911 commented Feb 10, 2025

Is the PR replacing PR #15 ?

@petrasovaa
Copy link
Contributor

Closing, I added CONTRIBUTING.md in #44.

@petrasovaa petrasovaa closed this May 15, 2025
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