From 2eb5e5b89e6ba6afc7a02949b31b7c707f6110cb Mon Sep 17 00:00:00 2001 From: Myeip Date: Sat, 30 Nov 2024 07:45:54 -0500 Subject: [PATCH 1/2] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ae2fea..f0d6d77 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repo is the home of the Conventional Commits specification. -## Repo Layout + Layout We use [HUGO](https://gohugo.io/) as static site generator, so we use the [directory structure](https://gohugo.io/getting-started/directory-structure/) HUGO proposes. @@ -21,8 +21,7 @@ fixing typos, or adding more translations. Please don't hesitate to send a pull request. ### Adding a translation - -1. Create a new file in `./content/version/index.[lang].md` using the hugo command `hugo new [version]/index.[lang].md`. +m1. Create a new file`./content/version/index.[lang].md` using the hugo command `hugo new [version]/index.[lang].md`. 1. Ensure all files have the appropriate fields required (see others as an example).. 1. Add the language to the `config.yaml` file (see others as an example). From d483e2d5ff8eba87af9532ef1306791d4053ff31 Mon Sep 17 00:00:00 2001 From: Myeip Date: Sat, 30 Nov 2024 07:46:07 -0500 Subject: [PATCH 2/2] Delete README.md --- README.md | 50 -------------------------------------------------- 1 file changed, 50 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index f0d6d77..0000000 --- a/README.md +++ /dev/null @@ -1,50 +0,0 @@ -# ConventionalCommits.org - -[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) - -This repo is the home of the Conventional Commits specification. - - Layout - -We use [HUGO](https://gohugo.io/) as static site generator, so we use the [directory structure](https://gohugo.io/getting-started/directory-structure/) HUGO proposes. - -#### Our implementation - -* `./content`: contains all the versions of the specification. -* `./content/next/`: contains the version of the specification (where all the changes SHOULD be made). -* `./content/**/index.[lang].md`: contains the content of the specification, if a language is specified it's a translation. - -## Contributing - -We'd love your help refining the language of this specification, -fixing typos, or adding more translations. Please don't hesitate -to send a pull request. - -### Adding a translation -m1. Create a new file`./content/version/index.[lang].md` using the hugo command `hugo new [version]/index.[lang].md`. -1. Ensure all files have the appropriate fields required (see others as an example).. -1. Add the language to the `config.yaml` file (see others as an example). - -### Running project locally - -There's a docker-compose.yml file ready that will help you to check if the website looks good! -To run it make sure you have [docker-compose installed](https://docs.docker.com/compose/install/#install-compose) on your machine and just use the command `docker-compose up` to make it run locally. - -Once the website will be compiled, you can see the website visiting `http://localhost:1313` - -## Badges! - -Tell your users that you use the Conventional Commits specification: - -```markdown -[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) -``` - -## Thank you - -To **[Lorenzo D'Ianni](https://github.com/lorenzodianni)** for the great effort creating the CSS and the HTML for the new UI. - -To **[Netlify](https://www.netlify.com/)** to host our project, giving us a lot of [amazing built in functionality](https://www.netlify.com/features/) for free. - -To **[semver.org](https://github.com/mojombo/semver.org)**: we used [semver.org](https://github.com/mojombo/semver.org) as a blueprint for -the structure of this specification and the first version of the website.