Loading README.md +25 −9 Original line number Diff line number Diff line Loading @@ -59,22 +59,33 @@ You can simply put it as a Git submodule somewhere, like in a `vendors` folder o Then use symbolic links to reference all the needed files from the root of your repository. Note: if you plan to use either GitLab CI/CD or GitHub Actions to build your documentation, make sure to at least copy/adapt the corresponding files from the submodule. You can't just symlink those since the submodule won't be accessible when GitLab and GitHub looks for CI/CD or Actions files. The provided CI configuration takes care of initializing the submodule during build time, but they should be available in the main repo in order to do so. ## Manually copying Even simpler, copy all the relevant files from this repository into your project. ## Outside the project * The Onion TeX Slim repository can be installed anywhere in your system. * In fact, it does not need to be stored inside your project if you don't want to. * You just need to make sure to invoke the scripts from your project folder or pass the appropriate folder or file path as arguments to it's scripts. ## Other ways * `git-subtree(1)`. * ? ## Installation notes * If you plan to use either GitLab CI/CD or GitHub Actions to build your documentation, make sure to at least copy/adapt the corresponding files from the submodule. * You can't just symlink those since the submodule won't be accessible when GitLab and GitHub looks for CI/CD or Actions files. * The provided CI configuration takes care of initializing the submodule during build time, but they should be available in the main repo in order to do so. ## Repository layout Example repository layout: Loading @@ -88,7 +99,7 @@ Example repository layout: * vendors * onion-tex-slim ## Compiling ## Building all slides Onion TeX Slim can be used to build [Beamer][] PDFs from any Markdown file it finds, so it's recommened to place it in the top-level folder of your project Loading @@ -99,9 +110,14 @@ repository, just run the build script: vendors/onion-tex-slim/scripts/onion-tex-slim-build-all slides/ ## Building a single slide If invoked without arguments, the script above will build slides from all Markdown file it finds recursively from the current folder. You can also build a single slide deck: vendors/onion-tex-slim/scripts/onion-tex-slim-build-all \ vendors/onion-tex-slim/scripts/onion-tex-slim-build \ slides/slide-for-conference-1/slide-for-conference-1.md ## Makefile Loading Loading
README.md +25 −9 Original line number Diff line number Diff line Loading @@ -59,22 +59,33 @@ You can simply put it as a Git submodule somewhere, like in a `vendors` folder o Then use symbolic links to reference all the needed files from the root of your repository. Note: if you plan to use either GitLab CI/CD or GitHub Actions to build your documentation, make sure to at least copy/adapt the corresponding files from the submodule. You can't just symlink those since the submodule won't be accessible when GitLab and GitHub looks for CI/CD or Actions files. The provided CI configuration takes care of initializing the submodule during build time, but they should be available in the main repo in order to do so. ## Manually copying Even simpler, copy all the relevant files from this repository into your project. ## Outside the project * The Onion TeX Slim repository can be installed anywhere in your system. * In fact, it does not need to be stored inside your project if you don't want to. * You just need to make sure to invoke the scripts from your project folder or pass the appropriate folder or file path as arguments to it's scripts. ## Other ways * `git-subtree(1)`. * ? ## Installation notes * If you plan to use either GitLab CI/CD or GitHub Actions to build your documentation, make sure to at least copy/adapt the corresponding files from the submodule. * You can't just symlink those since the submodule won't be accessible when GitLab and GitHub looks for CI/CD or Actions files. * The provided CI configuration takes care of initializing the submodule during build time, but they should be available in the main repo in order to do so. ## Repository layout Example repository layout: Loading @@ -88,7 +99,7 @@ Example repository layout: * vendors * onion-tex-slim ## Compiling ## Building all slides Onion TeX Slim can be used to build [Beamer][] PDFs from any Markdown file it finds, so it's recommened to place it in the top-level folder of your project Loading @@ -99,9 +110,14 @@ repository, just run the build script: vendors/onion-tex-slim/scripts/onion-tex-slim-build-all slides/ ## Building a single slide If invoked without arguments, the script above will build slides from all Markdown file it finds recursively from the current folder. You can also build a single slide deck: vendors/onion-tex-slim/scripts/onion-tex-slim-build-all \ vendors/onion-tex-slim/scripts/onion-tex-slim-build \ slides/slide-for-conference-1/slide-for-conference-1.md ## Makefile Loading
