3,699
edits
AniDB:CSS DEV: Difference between revisions
→Adding a new project
mNo edit summary |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}} | ||
This pages content is centred around CSS development via AniDB's | This pages content is centred around CSS development via AniDB's GIT. The goals of the GIT are: | ||
# Keeping track of all CSS styles. | # Keeping track of all CSS styles. | ||
# Version control for developers. | # Version control for developers. | ||
| Line 7: | Line 7: | ||
# Automatic update of the drop down menu in the [[profile]]. | # Automatic update of the drop down menu in the [[profile]]. | ||
{{eyecatch|Note|You should build your style on already existing code. Check the folder ''' | {{eyecatch|Note|You should build your style on already existing code. Check the folder '''common'''. Examples can be found in '''sub'''.}} | ||
==Getting the Source of a Style== | ==Getting the Source of a Style== | ||
If you only want to get the latest version of all files belonging to a particular style, you don't need to install an | If you only want to get the latest version of all files belonging to a particular style, you don't need to install an GIT client. A simpler approach would be to download the files from the GIT repository with your web browser. | ||
To do that go to [https://git.anidb.net/anidb/ | To do that go to [https://git.anidb.net/anidb/css/tree/master gitlab] and click the download link. | ||
If you want to contribute your own styles, you will need to install a git client. | If you want to contribute your own styles, you will need to install a git client. | ||
==Connecting to GIT== | ==Connecting to GIT== | ||
[https://git.anidb.net/anidb/ | [https://git.anidb.net https://git.anidb.net] - [https://git.anidb.net/anidb/css/tree/master Direct access to public repo] | ||
For write access | For write access just sign up to the git. If you have further questions feel free to ask in {{irclink|anidb-dev}} or {{irclink|anidb}}. | ||
If you have further questions feel free to ask in {{irclink|anidb-dev}} or {{irclink|anidb}}. | |||
===Committing=== | ===Committing=== | ||
After you have edited, added or even deleted some things you still have to commit your changes. This will write the things to the | After you have edited, added or even deleted some things you still have to commit your changes. This will write the things to the GIT. | ||
You can commit on a file or dirlevel. Meaning you can commit a big change with multiple files or folders involved or just specific files. '''To not spam us all into oblivion with | You can commit on a file or dirlevel. Meaning you can commit a big change with multiple files or folders involved or just specific files. '''To not spam us all into oblivion with GIT mails it's recommended to bundle some commits.''' | ||
Take also note that you should before editing anything '''always''' update your local files with the ones in the | Take also note that you should before editing anything '''always''' update your local files with the ones in the GIT. | ||
==Adding a new project== | ==Adding a new project== | ||
There are a few things that needs to get done when adding a new project: | There are a few things that needs to get done when adding a new project: | ||
# Add a new dir for your project in the CSS folder (<tt> | # Add a new dir for your project in the CSS folder (<tt>/{your_style}</tt>) | ||
# Name the dir whatever you want, but '''NO SPACES!'''. | # Name the dir whatever you want, but '''NO SPACES!'''. | ||
# If you are using images different from the AniDB ones add a <tt>/images/</tt> dir below your project (i.e. <tt> | # If you are using images different from the AniDB ones add a <tt>/images/</tt> dir below your project (i.e. <tt>/{your_style}/images</tt>) | ||
#* You may use sub-folders below that one if you want. | #* You may use sub-folders below that one if you want. | ||
# Add a screenshot and a thumbnail of your style in the images folder with the following specifications: | # Add a screenshot and a thumbnail of your style in the images folder with the following specifications: | ||
| Line 51: | Line 49: | ||
In the end you should end up with a structure like this: | In the end you should end up with a structure like this: | ||
/<your project> | |||
/<your project>/description | |||
/<your project>/images | |||
/<your project>/images/screenshot.png | |||
/<your project>/images/thumbnail.png | |||
==Merging & Hosting== | ==Merging & Hosting== | ||