From 8d12a3f5233ba72873069eb1cba5aeac849e9e6d Mon Sep 17 00:00:00 2001 From: toma <403-toma@users.noreply.gitlab.servus.at> Date: Thu, 22 Feb 2024 20:44:56 +0100 Subject: [PATCH] Update README.md --- README.md | 51 +-------------------------------------------------- 1 file changed, 1 insertion(+), 50 deletions(-) diff --git a/README.md b/README.md index 07dd8c0..c448a0b 100644 --- a/README.md +++ b/README.md @@ -2,54 +2,5 @@ A new template for the Design for Physical Prototyping project documentation. It uses the static site generator [Hugo](https://gohugo.io/) to generate a web pages from Markdown files with the [Hugo Book Theme](https://github.com/alex-shpak/hugo-book) and the theme component [hugo-video](https://github.com/martignoni/hugo-video). -To get started with your documentation, generate your own repository by clicking "[use this template]" or clone this repository. -Using GitHub pages you can access your documentation via [https://YOUR-GITHUB-USERNAME.github.io/YOUR-REPO-NAME](https://pretoms.github.io/dpp_docs/). - -# Quickstart - -For working on your documentation it is recommended to host your local Hugo instance and to use a text editor of your choice to edit the Markdown files. - -First install Hugo. -## Windows -Use PowerShell to install the extended version of Hugo with winget. Add <kbd>%localappdata%\microsoft\winget\packages</kbd> to your [path variable](https://windowsloop.com/how-to-add-to-windows-path/). -```bash -winget install Hugo.Hugo.Extended -``` - -## Linux -```bash -sudo apt install hugo -``` - -## Mac OS -Install Hugo using the free and open source package manager [Homebrew](https://brew.sh/). This will install the extended edition of Hugo. - -```bash -brew install hugo -``` - -# Clone - -Make sure you have [Git](https://git-scm.com/) installed on your system. -Clone your repository to your system. -Change active directory to the cloned repository and run the Hugo server. - -```bash -git clone <your-repo> <target-directory> -cd C:\your\local\repository\path -hugo server --minify -``` - -## Replace the content of the template pages - -Update the following files to your own content: - -* rename project folder <kbd>content/docs/projects/our_project</kbd> to the title of your project and remove all files but <kbd>_index.md</kbd>. -* <kbd>README.md</kbd> (information for those who access your repository site on GitHub: replace it with your text or just delete content and leave it empty) - -Put all images, videos and GIFs you want to embed in your documentation into the assets folder. - -Then visit http://localhost:1313 to view the documentation. - -[use this template]: https://github.com/pretoms/dpp_docs/generate +[](https://gitlab.servus.at/toma/physical-prototyping-projects/-/commits/main) -- GitLab