Skip to content

Extend README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 26, 2024
Merged

Extend README #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de3cd3a
Truncate Jaker's post
deccer Oct 26, 2024
56d6192
Explain truncate comment in README
deccer Oct 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ The Graphics Programming Blog - A collection of technical articles, project post

In this case you can also see how jaker put his article into `2024/2024-10-17-glsl-development-made-shrimple/index.md`

- Third important bit is to place a truncate line in your article, so that the generator doesnt take the whole post as the post preview :)

Use a `<!-- truncate -->` comment to limit blog post size in the list view.

- Consider adding your author tag to blog/authors.yml. Simply check how jaker/deccer were added and massage yours accordingly. The key of each entry is also the value which goes into the `authors: ["author_here", "coauthor"]` thing.

- Try it out locally:
Expand Down
2 changes: 2 additions & 0 deletions blog/2024/2024-10-17-glsl-development-made-shrimple/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ tags: ["glsl", "opengl", "vulkan", "beginner", "visual studio", "visual studio c

Life is so much better when you get instant feedback on the errors you make.

<!-- truncate -->

## Visual Studio Code
- [GLSL Lint](https://marketplace.visualstudio.com/items?itemName=dtoplak.vscode-glsllint): provides syntax highlighting and error detection.
- Requires glslangValidator from [the Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) or compiled yourself. The path to the executable must be supplied in the extension settings.
Expand Down