forked from blinksh/blink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Carlos Cabanero
committed
Jun 14, 2016
0 parents
commit ae3ccd8
Showing
92 changed files
with
9,061 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
Language: Cpp | ||
AccessModifierOffset: -2 | ||
AlignEscapedNewlinesLeft: false | ||
AlignTrailingComments: true | ||
AllowAllParametersOfDeclarationOnNextLine: true | ||
AllowShortFunctionsOnASingleLine: false | ||
AllowShortIfStatementsOnASingleLine: false | ||
AllowShortLoopsOnASingleLine: false | ||
AlwaysBreakBeforeMultilineStrings: false | ||
AlwaysBreakTemplateDeclarations: false | ||
BinPackParameters: true | ||
BreakBeforeBinaryOperators: false | ||
BreakBeforeBraces: Linux | ||
BreakBeforeTernaryOperators: true | ||
BreakConstructorInitializersBeforeComma: false | ||
ColumnLimit: 0 | ||
CommentPragmas: '^ IWYU pragma:' | ||
ConstructorInitializerAllOnOneLineOrOnePerLine: false | ||
ConstructorInitializerIndentWidth: 2 | ||
ContinuationIndentWidth: 2 | ||
Cpp11BracedListStyle: true | ||
DerivePointerBinding: false | ||
ExperimentalAutoDetectBinPacking: false | ||
IndentCaseLabels: true | ||
IndentFunctionDeclarationAfterType: true | ||
IndentWidth: 2 | ||
MaxEmptyLinesToKeep: 2 | ||
NamespaceIndentation: None | ||
ObjCSpaceAfterProperty: true | ||
ObjCSpaceBeforeProtocolList: true | ||
ObjCBlockIndentWidth: 2 | ||
PenaltyBreakBeforeFirstCallParameter: 19 | ||
PenaltyBreakComment: 300 | ||
PenaltyBreakFirstLessLess: 120 | ||
PenaltyBreakString: 1000 | ||
PenaltyExcessCharacter: 1000000 | ||
PenaltyReturnTypeOnItsOwnLine: 60 | ||
PointerBindsToType: false | ||
SpaceBeforeAssignmentOperators: true | ||
SpaceBeforeParens: ControlStatements | ||
SpaceInEmptyParentheses: false | ||
SpacesBeforeTrailingComments: 1 | ||
SpacesInAngles: false | ||
SpacesInContainerLiterals: true | ||
SpacesInCStyleCastParentheses: false | ||
SpacesInParentheses: false | ||
Standard: Cpp11 | ||
TabWidth: 2 | ||
UseTab: Never |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
*~ | ||
#*# | ||
.DS_Store | ||
|
||
## Build generated | ||
build/ | ||
DerivedData/ | ||
|
||
## Various settings | ||
*.pbxuser | ||
!default.pbxuser | ||
*.mode1v3 | ||
!default.mode1v3 | ||
*.mode2v3 | ||
!default.mode2v3 | ||
*.perspectivev3 | ||
!default.perspectivev3 | ||
xcuserdata/ | ||
|
||
## libs | ||
Frameworks/include/* | ||
Frameworks/lib/* | ||
|
||
## Other | ||
*.moved-aside | ||
*.xcuserstate | ||
|
||
## Obj-C/Swift specific | ||
*.hmap | ||
*.ipa | ||
*.dSYM.zip | ||
*.dSYM |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[submodule "Frameworks/UICKeyChainStore"] | ||
path = Frameworks/UICKeyChainStore | ||
url = https://github.com/kishikawakatsumi/UICKeyChainStore.git | ||
[submodule "Frameworks/MBProgressHUD"] | ||
path = Frameworks/MBProgressHUD | ||
url = https://github.com/jdg/MBProgressHUD.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Carlos Cabanero <cc at blink.sh> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
# Building | ||
Blink is currently in Alpha stage. If you would like to test it, | ||
please tweet us @BlinkShell. You do not have to compile Blink unless | ||
you want to make modifications to the code, which is accepted under the | ||
[GPL License](http://github.com/blinksh/blink/COPYING). | ||
|
||
## Cloning | ||
Clone Blink into your local repository and make sure to obtain any submodules: | ||
git submodule init | ||
git submodule update | ||
|
||
## Dependencies | ||
Blink makes use of multiple dependencies that you have to compile | ||
separately before building Blink itself. There are simple scripts available | ||
to perform this operation. | ||
- [Libssh2](https://github.com/x2on/libssh2-for-iOS) | ||
- [OpenSSL](https://github.com/x2on/OpenSSL-for-iPhone/tree/ee4665d089a91d7382fcb22b0b09c85a02935739) | ||
- [Protobuf](https://gist.github.com/BennettSmith/9487468ae3375d0db0cc) | ||
- [Mosh](https://github.com/blinksh/build-mosh) | ||
|
||
Please note that Blink currently only supports armv64 and x86_64 (simulator) | ||
platforms, so compilation for other architectures is not necessary. | ||
### Installation | ||
#### Libraries | ||
All Mosh dependencies must be installed under the Framework folder | ||
depending on the type of output. We are working on making all the | ||
dependencies a .framework bundle, but it is a complicated project. | ||
Framework bundles can be left at the Framework folder root, while | ||
.a and .h files must go to the corresponding lib and include folder. | ||
|
||
To install Libssh2 and OpenSSL in your Blink repository, please copy | ||
the .framework files to the Framework folders. | ||
|
||
For Protobuf, please copy the generated .h and .a files to the | ||
Framework/include and Framework/lib respectively. | ||
|
||
Mosh will output multiple .a library files, and unfortunately we | ||
didn't find a simple way to just aggregate all of them yet. Please | ||
copy all the .a library files from the output folder (mosh/output) to lib | ||
folder and paste the src/frontend/MoshiOSController.h to the header folder. | ||
|
||
Blink also makes use of two other projects, but those can be compiled | ||
within the same project: | ||
- UICKeyChainStore | ||
- MBProgressHUD | ||
|
||
Blink uses Linenoise as part of its code for the simple terminal interface. | ||
It is provided within the project due to the big changes made to it. We will | ||
change this piece at some point. | ||
|
||
#### Resources | ||
Blink's Terminal is running from JavaScript code linked at runtime. | ||
Most of the available open source terminals can be made to work with Blink, | ||
just by providing a "write" and "signal" functions. An example of this | ||
is provided in the Resources/term.html file. | ||
|
||
You can aggregate any terminal you want to the bundle. We are currently | ||
using [Chromium's HTerm](https://chromium.googlesource.com/apps/libapps/+/master/hterm), | ||
but we have been also successful plugin other terminals like [Terminal.js](http://terminal.js.org). | ||
|
||
Generate a single term.js file and drop it under the Resources folder. | ||
|
||
## Compiling | ||
Please note that to compile and install Blink in your personal | ||
devices, you need to comply with Apple Developer Terms and Conditions, | ||
including obtaining a Developer License for that purpose. You will also | ||
need all the XCode command line developer tools and SDKs provided under | ||
a separate license by Apple Inc. | ||
|
||
Blink uses a standard .xcodeproj file. Any missing files will be marked in | ||
red, what can be used to test your installation. | ||
|
||
To configure the project: | ||
1. Under Targets > Blink > General > Identities set a unique Bundle Identifier. | ||
2. Under Targets > Blink > General > Identities set your Team. | ||
3. If you do not want to make use of HockeyApp, please set the preprocessor variable | ||
HOCKEYSDK = 0 under Build Settings. | ||
4. You might be requested to accept your profile or setup your developer account | ||
with XCode, follow the proper Apple Developer documentation in that case. | ||
|
||
As a standard XCode project, just run it with Cmd-R. |
Oops, something went wrong.