Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Files and Documents #14

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 10 additions & 10 deletions CODE_OF_CONDUCT.md
Expand Up @@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Demonstrating empathy and kindness toward other people,
* Being respectful of differing opinions, viewpoints, and experiences,
* Giving and gracefully accepting constructive feedback,
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
and learning from the experience,
* Focusing on what is best not just for us as individuals, but for the
overall community
overall community.

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
advances of any kind,
* Trolling, insulting or derogatory comments, and personal or political attacks,
* Public or private harassment,
* Publishing others' private information, such as a physical or email
address, without their explicit permission
address, without their explicit permission,
* Other conduct which could reasonably be considered inappropriate in a
professional setting
professional setting.

## Enforcement Responsibilities

Expand Down
8 changes: 4 additions & 4 deletions INSTALL.MD
Expand Up @@ -5,7 +5,7 @@
---


##### If you run the GUI from nighly builds or source, you need to manually have the ccextractor binary in your PATH (`ccextractorwinfull.exe` if you are on windows or `ccextractor` if you are on linux/macOS)
##### If you run the GUI from nighly builds or source, you need to manually have the ccextractor binary in your PATH (`ccextractorwinfull.exe` if you are on windows or `ccextractor` if you are on linux/macOS).

---

Expand All @@ -17,12 +17,12 @@
- This method only makes sense for people who actually want to debug the app. If you want to skip the hastle of installing frameworks and stuff just go the nightly way, the CI does these below steps for you automatically on every commit.
- To build the GUI from source first install flutter from [here](https://flutter.dev/docs/get-started/install) for your operating system.
- Switch to flutter master channel using `flutter channel master && flutter upgrade`
- Next enable the flutter platform specific flag with `flutter config --enable-<platform>-desktop`, more info on this [here](https://flutter.dev/desktop)
- Next enable the flutter platform specific flag with `flutter config --enable-<platform>-desktop`, more info on this [here](https://flutter.dev/desktop).
- Then clone [this](https://github.com/CCExtractor/ccextractorfluttergui) repository and run `flutter run -d <platform> --release` to run the app.
- To install the Gui you will need to build it using `flutter build <platform> --release`. The release builds should be located under /build/\<platform>
- To install the Gui you will need to build it using `flutter build <platform> --release`. The release builds should be located under /build/\<platform>.

### Additional macOS steps:
- If you build and install from source, you will probably get a `Process not permitted operation error` to fix remove the below lines from macos/*.entitlements files
- If you build and install from source, you will probably get a `Process not permitted operation error` to fix remove the below lines from macos/*.entitlements files.

```
<key>com.apple.security.app-sandbox</key>
Expand Down
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -22,9 +22,9 @@ The GUI basically uses dart's [process](https://api.dart.dev/stable/2.13.4/dart-
Depending on your OS of choice, one or multiple options are available.

### Windows
- (preferred) [Download the .msi](https://github.com/CCExtractor/ccextractor/releases) to install CCExtractor and this GUI
- Download the built GUI from the releases on this repository. You'll have to provide a CCExtractor binary yourself
- Download this repository and build the GUI by yourself. You'll have to provide a CCExtractor binary yourself
- (preferred) [Download the .msi](https://github.com/CCExtractor/ccextractor/releases) to install CCExtractor and this GUI.
- Download the built GUI from the releases on this repository. You'll have to provide a CCExtractor binary yourself.
- Download this repository and build the GUI by yourself. You'll have to provide a CCExtractor binary yourself.

### Linux
Executables for Linux can be found [here](https://nightly.link/CCExtractor/ccextractorfluttergui/workflows/create_artifacts/master) or on the [releases page](https://github.com/CCExtractor/ccextractorfluttergui/releases). Both still require to get ccextractor manually.
Expand All @@ -34,11 +34,11 @@ MacOS requires you to build the GUI from source and get ccextractor manually. Fo


## Usage
For users new to GUI check out the usage guide [here](USAGE.MD). You can also check all the options avaiable in ccextractor [here](https://ccextractor.org/public/general/command_line_usage/)
For users new to GUI check out the usage guide [here](USAGE.MD). You can also check all the options avaiable in ccextractor [here](https://ccextractor.org/public/general/command_line_usage/).


## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. For more details, see the [Contributing Page](CONTRIBUTING.md)
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. For more details, see the [Contributing Page](CONTRIBUTING.md).

## License
[MIT License](LICENSE)
Expand Down
8 changes: 4 additions & 4 deletions USAGE.MD
Expand Up @@ -19,16 +19,16 @@ The GUI is mainly divided into 2 parts, the home screen and the settings screen(

## Settings screen(S)

The GUI has tons of options so they are seperated into several settings screens. All of the options are saved locally in a json file so you can save the settings you need frequently,
The GUI has tons of options so they are seperated into several settings screens. All of the options are saved locally in a json file so you can save the settings you need frequently, details of which are as follows:

![image](https://ccextractor.org/images/flutter_gui/settings.png)


- Each setting screen has a current command container at the top which shows you the exact command with the selected settings you will run when you click start all on the home page.
- To update the sttings, simply toggle the option or select the option from the dropdown menu.
- To update the settings, simply toggle the option or select the option from the dropdown menu.
- **To save settings which have a textfield press enter after you enter your setting value in the textfield.**
- You can also reset the settings back to the default value with the reset settings button on the top right corner of each of the settings page
- You can also reset the settings back to the default value with the reset settings button on the top right corner of each of the settings page.



To report any bugs, please file a issue on github or get in touch with us on slack. Most CCExtractor developers hang out in a slack team. You're welcome to request an invitation [here](https://ccextractor.org/public/general/support/)
To report any bugs, please file a issue on github or get in touch with us on slack. Most CCExtractor developers hang out in a slack team. You're welcome to request an invitation [here](https://ccextractor.org/public/general/support/).
1 change: 1 addition & 0 deletions macos/Flutter/Flutter-Debug.xcconfig
@@ -1 +1,2 @@
#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"
#include "ephemeral/Flutter-Generated.xcconfig"
1 change: 1 addition & 0 deletions macos/Flutter/Flutter-Release.xcconfig
@@ -1 +1,2 @@
#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"
#include "ephemeral/Flutter-Generated.xcconfig"
40 changes: 40 additions & 0 deletions macos/Podfile
@@ -0,0 +1,40 @@
platform :osx, '10.11'

# CocoaPods analytics sends network stats synchronously affecting flutter build latency.
ENV['COCOAPODS_DISABLE_STATS'] = 'true'

project 'Runner', {
'Debug' => :debug,
'Profile' => :release,
'Release' => :release,
}

def flutter_root
generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'ephemeral', 'Flutter-Generated.xcconfig'), __FILE__)
unless File.exist?(generated_xcode_build_settings_path)
raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure \"flutter pub get\" is executed first"
end

File.foreach(generated_xcode_build_settings_path) do |line|
matches = line.match(/FLUTTER_ROOT\=(.*)/)
return matches[1].strip if matches
end
raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Flutter-Generated.xcconfig, then run \"flutter pub get\""
end

require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root)

flutter_macos_podfile_setup

target 'Runner' do
use_frameworks!
use_modular_headers!

flutter_install_all_macos_pods File.dirname(File.realpath(__FILE__))
end

post_install do |installer|
installer.pods_project.targets.each do |target|
flutter_additional_macos_build_settings(target)
end
end
16 changes: 8 additions & 8 deletions pubspec.lock
Expand Up @@ -28,7 +28,7 @@ packages:
name: async
url: "https://pub.dartlang.org"
source: hosted
version: "2.8.1"
version: "2.8.2"
bloc:
dependency: "direct main"
description:
Expand Down Expand Up @@ -112,7 +112,7 @@ packages:
name: characters
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.0"
version: "1.2.0"
charcode:
dependency: transitive
description:
Expand Down Expand Up @@ -430,7 +430,7 @@ packages:
name: matcher
url: "https://pub.dartlang.org"
source: hosted
version: "0.12.10"
version: "0.12.11"
meta:
dependency: transitive
description:
Expand Down Expand Up @@ -717,21 +717,21 @@ packages:
name: test
url: "https://pub.dartlang.org"
source: hosted
version: "1.17.10"
version: "1.17.12"
test_api:
dependency: transitive
description:
name: test_api
url: "https://pub.dartlang.org"
source: hosted
version: "0.4.2"
version: "0.4.3"
test_core:
dependency: transitive
description:
name: test_core
url: "https://pub.dartlang.org"
source: hosted
version: "0.4.0"
version: "0.4.2"
timing:
dependency: transitive
description:
Expand Down Expand Up @@ -801,7 +801,7 @@ packages:
name: vector_math
url: "https://pub.dartlang.org"
source: hosted
version: "2.1.0"
version: "2.1.1"
vm_service:
dependency: transitive
description:
Expand Down Expand Up @@ -868,5 +868,5 @@ packages:
source: hosted
version: "3.1.0"
sdks:
dart: ">=2.12.0 <3.0.0"
dart: ">=2.14.0 <3.0.0"
flutter: ">=2.0.0"