https://github.com/motrellin/comoproj

Template for Github Coq-Projects
https://github.com/motrellin/comoproj

coq template-project

Last synced: 29 days ago
JSON representation

Template for Github Coq-Projects

• Host: GitHub
• URL: https://github.com/motrellin/comoproj
• Owner: motrellin
• Created: 2024-05-19T20:06:43.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-24T22:23:01.000Z (6 months ago)
• Last Synced: 2024-11-06T05:43:21.364Z (3 months ago)
• Topics: coq, template-project
• Language: Makefile
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Template for Coq-Projects on Github

This is a template for Github Coq-Projects.

## Usage

You can use this template by clicking on the "Use this template"-Button:

![grafik](https://github.com/motrellin/comoproj/assets/105235679/450ab9bf-22ff-4961-9091-4959c8643471)

Choose to "Create a new repository". You should choose to create a public repository in order to deploy to Github Pages which is a main advantage of this project. 

Make sure to enable Github Pages for your project. (Source: Github Actions)

After that, clone your new repository and update the `meta.yml`. 

You should ahve a look at the [`ref.yml`](https://github.com/coq-community/templates/blob/master/ref.yml) from Coq-Community.

You must also update the following line in the `Makefile`:

```

COMPONENTS := theories:CoMoProj

```

It should match your choosen namespace.

Now execute

```

./generate.sh

git add .

git commit

git push

```

To generate meta information about your project.

## Licensing

Do not hesitate to use this template.

Please note, that the [Makefile](Makefile) is licensed under GNU General Public License v3.0.

It was first published at [Gitlab](https://gitlab.cs.fau.de/oc59yqul/template-coq/-/blob/main/Makefile?ref_type=heads)