diff --git a/README.md b/README.md index 3b93427..0ea31d8 100644 --- a/README.md +++ b/README.md @@ -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? +[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 -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/) -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 +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 -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 +- 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 +- 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 \ No newline at end of file diff --git a/index.qmd b/index.qmd index 775b75d..3690e76 100644 --- a/index.qmd +++ b/index.qmd @@ -1,5 +1,5 @@ --- -title: "Learn GRASS GIS" +title: "Learn GRASS GIS (An Open-Source GIS)" listing: contents: - content/tutorials @@ -9,4 +9,4 @@ listing: filter-ui: [title, categories] page-layout: full title-block-banner: false ---- \ No newline at end of file +---