Skip to content

Commit fe7993c

Browse files
committed
Simplify readme yml format
1 parent c6e65c9 commit fe7993c

3 files changed

Lines changed: 13 additions & 20 deletions

File tree

readme.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def self.root
2222

2323
textlines << $config['root']['text']
2424

25-
textlines << $config['softwares'].map do |software_name, software|
25+
textlines << $config['softwares'].map do |software|
2626
Render.software_projects(software, pinned_only: true, path_titles: true)
2727
end
2828

@@ -63,7 +63,7 @@ def self.software_projects(software, options = {})
6363
textlines << Dir[project_dir].map do |path|
6464
path.sub(/^\.\//, '')
6565
end.select do |path|
66-
if software['projects_in_directories']
66+
if software['projects_in_dirs']
6767
true
6868
else
6969
File.file?(path)

readme.yml

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,12 @@ root:
1313
## Most interesting works
1414
1515
softwares:
16-
Blender:
17-
name: 'Blender'
16+
- name: 'Blender'
1817
dir: 'Blender'
1918
projects:
2019
select_by_color.py:
2120
text: A script for selecting objects by material color.
22-
Cyril:
23-
name: 'Cyril'
21+
- name: 'Cyril'
2422
dir: 'Cyril'
2523
text: |
2624
## How to run examples
@@ -33,32 +31,28 @@ softwares:
3331
- 'sprites'
3432
- 'code_default'
3533
- 'code_empty'
36-
projects_in_directories: true
34+
projects_in_dirs: true
3735
projects:
3836
code_old:
3937
pinned: true
40-
KodeLife:
41-
name: 'KodeLife'
38+
- name: 'KodeLife'
4239
dir: 'KodeLife'
4340
projects:
4441
pseudoGlitch.klproj:
4542
pinned: true
46-
Processing:
47-
name: 'Processing'
43+
- name: 'Processing'
4844
dir: 'Processing'
49-
projects_in_directories: true
45+
projects_in_dirs: true
5046
projects:
5147
hacking:
5248
pinned: true
5349
text: |
5450
This projects generates a glitched code effect. The code sample is read from a file,
5551
then a few text transformations are applied.
5652
Output can be grabbed via Spout.
57-
QuartzComposer:
58-
name: 'QuartzComposer'
53+
- name: 'QuartzComposer'
5954
dir: 'QuartzComposer'
60-
TouchDesigner:
61-
name: 'TouchDesigner'
55+
- name: 'TouchDesigner'
6256
dir: 'TouchDesigner'
6357
projects:
6458
camera_gamecontroller.toe:
@@ -102,13 +96,12 @@ softwares:
10296
text: Audioreactive scene.
10397
text_3d_instances.toe:
10498
pinned: true
105-
Vuo:
99+
- name: 'Vuo'
100+
dir: 'Vuo'
106101
text: |
107102
* `compositions` - standalone projects
108103
* `nodes` - Vuo modules, put them in in `~/Library/Application Support/Vuo/Modules`
109104
* `generators` - projects prepared to be embeded in other softwares, e.g. in VDMX
110-
name: 'Vuo'
111-
dir: 'Vuo'
112105
project_dirs:
113106
- 'compositions'
114107
- 'generators'

readme_build.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
require_relative 'readme'
22

3-
$config['softwares'].each do |software_name, software|
3+
$config['softwares'].each do |software|
44
textlines = Render.software(software)
55
Writer.software_readme(software, textlines)
66
end

0 commit comments

Comments
 (0)