Skip to content
Snippets Groups Projects
Commit 14ed441a authored by Thibaut DE SAIVRE's avatar Thibaut DE SAIVRE
Browse files

prepare readme for Java

parent 884bc268
No related branches found
No related tags found
No related merge requests found
# Ignore the output directory
out/
\ No newline at end of file
out/
# Just to be safe : ignore all output files
*.class
\ No newline at end of file
# Output and source directories
SOURCE_DIR = src
OUTPUT_DIR = out
......
TODO: quel output pour java + commandes avec vscode
TODO: pour Linux VSCode avec le makefile, sinon faire à la main
# Template Java Project
## Java environment
Where install jdk, path to java and javac
In order to be able to compile and run Java code, you need to install a JDK (Java Development Kit) on your computer.
A JDK contains a java compiler (`javac`) and a java interpreter (`java` - JRE = Java Runtime Environment).
You can find JDKs at https://openjdk.org/install/ (latest JDK at https://jdk.java.net/).
If you are using Linux or MacOS, you should install a JDK using your package manager (apt, brew, ...).
### Commands
How this project is configured + the commands
TODO : for Windows in particular, because there is no default Makefile support
### Linux / MacOS - Makefile
TODO : how to use the makefile
## VSCode Project Settings
Relevant settings with Java :
- format on save
## Formatter - Java Red Hat
The Java extension for VSCode provides a formatter.
Using a formatter ensures that the code you and your team write is consistent.
You should always use a formatter.
### Git
Some common gitignores for a Java project :
- `out/` : the compiled output. In this project we specify to the compiler that it must output its `.class` compiled files to this directory. It may not be the same for every project.
- `*.class` : just to be safe : be sure not to version output files.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment