doc_contract 0.1.1 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +37 -0
- data/lib/doc_contract/version.rb +1 -1
- data/vendor/assets/doc-contract/pandoc-templates/eisvogel.tex +1065 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background1.pdf +70 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background10.pdf +69 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background11.pdf +0 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background2.pdf +0 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background3.pdf +0 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background4.pdf +69 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background5.pdf +70 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background6.pdf +0 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background7.pdf +68 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background8.pdf +0 -0
- data/vendor/assets/doc-contract/titlepage-backgrounds/background9.pdf +69 -0
- metadata +19 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 19b2e7620eb38e143f377e284ef114d73d8ecaded35f8922d0b75e7c0928f6a5
|
4
|
+
data.tar.gz: 57633ce96bae4ced8db47c6e2a0071b7447b61ecc145358e7102e4970072e8e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f492dd061c367f22446893d10173575757f9720d003b43e366f8cbbddaef5bb2166c171eeb5cdfdbec0c4686cc3e61a6d4388b387479fbe22f41c4a61f2017ef
|
7
|
+
data.tar.gz: fab2d0c24a47f34cf2461e7553ff368a685ee346aaa50c45cb6f3a95fe32ef826a200b526fbd8164bb1310db6e7b5d700a18f3918fc181df73401fe4c202bb9a
|
data/README.md
CHANGED
@@ -94,6 +94,8 @@ a VAT of 21%.
|
|
94
94
|
And more contract stuff
|
95
95
|
```
|
96
96
|
|
97
|
+
NOTE: the `to_words` handlebars helper uses the (numbers\_and\_words)[https://github.com/kslazarev/numbers\_and\_words] gem.
|
98
|
+
|
97
99
|
## Installation
|
98
100
|
|
99
101
|
### Install the system dependencies
|
@@ -184,8 +186,43 @@ To change for example the icon, see the options at the [fomantic-ui](https://fom
|
|
184
186
|
|
185
187
|
### Screenshot
|
186
188
|
![Edit template scnreenshot](/spec/dummy/public/DocContract-template-edit.png)
|
189
|
+
|
187
190
|
## Contributing
|
191
|
+
There are many ways to contribute. Here some example steps that should work.
|
192
|
+
|
193
|
+
### 1. Fork the repository
|
194
|
+
Go to the original repository at https://gitlab.com/benja-2/doc\_contract and [fork](https://gitlab.com/benja-2/doc_contract/-/forks/new) the project.
|
195
|
+
Then `git clone` your code on your local computer.
|
196
|
+
|
197
|
+
If you are in the git repository directory you can tell your system to use the local code when actually the
|
198
|
+
gitlab repository is specified for faster debugging. To achieve this type:
|
199
|
+
|
200
|
+
```bash
|
201
|
+
bundle config local.doc_contract .
|
202
|
+
```
|
203
|
+
|
204
|
+
### 2. Add your forked codebase to a project
|
205
|
+
To start from zero, create a new rails (> 7) project and add the `doc_contract` gem configured to use `gitlab` as a base:
|
206
|
+
|
207
|
+
```bash
|
208
|
+
rails new my_doc_contract_project
|
209
|
+
cd my_doc_contract_project
|
210
|
+
```
|
211
|
+
|
212
|
+
Then in the `Gemfile`
|
213
|
+
```ruby
|
214
|
+
git_source(:gitlab) do |repo_name|
|
215
|
+
repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
|
216
|
+
"git@gitlab.com:#{repo_name}.git"
|
217
|
+
end
|
218
|
+
|
219
|
+
gem 'doc_contract', gitlab: '<your gitlab name>/doc_contract', branch: :master
|
220
|
+
```
|
188
221
|
Contribution directions go here.
|
189
222
|
|
223
|
+
## CHANGELOG
|
224
|
+
The CHANGELOG can be found using
|
225
|
+
[CHANGELOG.md](/CHANGELOG.md)
|
226
|
+
|
190
227
|
## License
|
191
228
|
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/lib/doc_contract/version.rb
CHANGED