README.md
1AIDEgen aims to automate the project setup process for developers to work on
2Java project in popular IDE environment. Developers no longer need to
3manually configure an IntelliJ project, such as all the project dependencies.
4It's a **command line tool** that offers the following features:
5
6* Configure Intellij or Android Studio project files with the relevant module
7 dependencies resolved.
8
9* Launch IDE for a specified sub-project or build target, i.e. frameworks/base
10 or Settings.
11
12* Launch IDE for a specified folder which contains build targets, i.e. cts.
13
14* Auto configure JDK and Android coding style for Intellij.
15
16## 1. Prerequisites:
17
18 IDE installed and run $ '. build/envsetup.sh && lunch' under Android source
19 root folder.
20
21## 2. Execution:
22
23 $ 'aidegen <module_name>... <module_path>...'
24 Example to generate and launch IntelliJ project for framework and
25 Settings:
26 $ aidegen Settings framework
27 $ aidegen packages/apps/Settings frameworks/base
28 $ aidegen packages/apps/Settings framework
29
30 $ 'aidegen <module> -i s'
31 Example to generate and launch Android Studio project for framework:
32 $ aidegen framework -i s
33
34## 3. More argument:
35
36 $ aidegen --help
37
38## 4. FAQ:
39
40 1. Q: If I already have an IDE project file, and I run command AIDEGen to
41 generate the same project file again, what’ll happen?
42 A: The former IDEA project file will be overwritten by the newly
43 generated one from the aidegen command.
44
45 2. Q: When do I need to re-run AIDEGen?
46 A: Re-run AIDEGen after repo sync.
47
48 3. Q: Does AIDEGen support debug log dump?
49 A: Use aidegen -v to get more debug information.
50
51 4. Q: After the aidegen command run locally, if there’s no IDEA with
52 project shown up, what can I do ?
53 A: Basic steps to do troubleshooting:
54 - Make sure development environment is set up, please refer to
55 prerequisites section.
56 - Check error message in the aidegen command output.
57
58# Hint
59 1. In Intellij, uses [File] > [Invalidate Caches / Restart…] to force
60 project panel updated when your IDE didn't sync.
61
62 2. If you run aidegen on a remote desktop, make sure there is no IntelliJ
63 running in a different desktop session.
64