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

Updated README with installation guide and contribution #16

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 96 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,108 @@
# Learn GRASS GIS

Welcome to the Learn GRASS GIS repository that hosts a Quarto-powered website
with a collection of tutorials and learning materials for [GRASS
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,


We welcome all contributions, including fixes, suggestions and complete tutorials.
If you're unsure where to start, feel free to open an issue to discuss your ideas.
### 🔹 1. Prerequisites
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/)
Comment on lines +9 to +12
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.


To contribute changes, use a "fork and pull request" workflow. This workflow is
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.

To get started, open your terminal and run:
git clone https://github.com/OSGeo/grass-tutorials.git cd grass-tutorials

shell
Copy
Edit

## License
### 🔹 3. Install Dependencies
Some tutorials may require additional dependencies.

The content in this repository is dual-licensed under the
[GNU Free Documentation License v1.2 or later](https://www.gnu.org/licenses/fdl-1.2.html)
(GFDL-1.2-or-later) and the
[Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)
(CC-BY-SA-4.0).
#### 📌 For Python-based tutorials
pip install -r requirements.txt

## Acknowledgments
shell
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.

U.S. National Science Foundation [award 2303651](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2303651).
#### 📌 For R-based tutorials (if applicable)
Rscript -e "install.packages(c('tidyverse', 'sf'))"

## Contact
csharp
Copy
Edit

For questions or suggestions, feel free to open an issue or reach out to the
maintainers through the [GRASS GIS community channels](https://grass.osgeo.org/community/).
### 🔹 4. Serve the Tutorials Locally
Since this project is powered by **Quarto**, you can preview the website locally:
quarto preview

arduino
Copy
Edit
After running the command, open your browser and go to:
http://localhost:4321

markdown
Copy
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

- Browse the tutorials directly from the [website](https://grass-tutorials.osgeo.org/).
- Use the **search bar** to find specific topics.
- If you want to modify or contribute new tutorials, check out the **[Contributing](#contributing)** section.

## 🤝 Contributing
We welcome all contributions, including:
- Fixes for existing tutorials
- Suggestions for improvements
- Adding new tutorials

If you're unsure where to start, **open an issue** to discuss your ideas.

### **How to Contribute**
1. **Fork this repository** on GitHub.
2. **Clone your fork**:
git clone https://github.com/YOUR-USERNAME/grass-tutorials.git

markdown
Copy
Edit
3. **Create a new branch**:
git checkout -b my-feature-branch

markdown
Copy
Edit
4. **Make your changes** and commit:
git add . git commit -m "Added new tutorial on XYZ"

markdown
Copy
Edit
5. **Push changes** and create a Pull Request:
git push origin my-feature-branch

markdown
Copy
Edit
For detailed contribution steps, refer to the **[GitHub Contribution Guide](https://github.com/OSGeo/grass/blob/main/doc/development/github_guide.md)**.

## 📜 License
The content in this repository is dual-licensed under:
- **[GNU Free Documentation License v1.2 or later](https://www.gnu.org/licenses/fdl-1.2.html)** (GFDL-1.2-or-later)
- **[Creative Commons Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/)** (CC-BY-SA-4.0)

## 📢 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

- This README now includes **installation steps, usage instructions, and contribution guidelines**.
- The guide ensures **new users** can easily install and explore the tutorials.
- Contributors can now follow a **clear workflow** for making updates.

🎉 **You're all set!** 🚀 Simply replace your existing `README.md` with this co
4 changes: 2 additions & 2 deletions index.qmd
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Learn GRASS GIS"
title: "Learn GRASS GIS <span style='font-size: 0.8em; color: gray;'>(An Open-Source GIS)</span>"
listing:
contents:
- content/tutorials
Expand All @@ -9,4 +9,4 @@ listing:
filter-ui: [title, categories]
page-layout: full
title-block-banner: false
---
---